<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/struc/heap_serializer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_58e412aa7ace8e71fc01678dc8765e7c.html">transport</a></li><li class="navelem"><a class="el" href="dir_a98fddea045b8b2df4350ebb1d483bf8.html">struc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">heap_serializer.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="heap__serializer_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Structured Transport</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2023 Akamai Technologies, Inc.; and other contributors.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Each commit is copyright by its respective author or author&#39;s employer.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Licensed under the MIT License:</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * THE SOFTWARE. */</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"></span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="heap__fixed__builder__capnp__msg__builder_8hpp.html">ipc/transport/struc/heap_fixed_builder_capnp_msg_builder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2error_8hpp.html">ipc/transport/struc/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">ipc/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1struc.html">ipc::transport::struc</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">/**</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * Value for Struct_builder::Session when no extra information is needed when serializing Struct_builder for</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * subsequent sending to another process.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * @see Struct_builder::Session concept.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> */</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Null__session.html">   45</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Null__session.html">Null_session</a> {};</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"></span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment">/**</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * the regular heap and serializing directly inside those segments.  That is, each mutation via payload_msg_builder()</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * may, as needed, trigger a `malloc()` (or similar) of size N passed to the ctor of Heap_fixed_builder; and</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * each buffer returned by emit_serialization() will be of size N or less.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * ### Failure mode ###</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * As long as each leaf capnp object set via mutation of payload_msg_builder() can be serialized in N bytes or fewer,</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * emit_serialization() shall succeed.  For fixed-size leaves this is generally not a problem; for reasonable N</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * in the KiB, things such as integers and enumerations won&#39;t be a problem.  However for variable-size</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * objects, particularly strings and blobs and lists and the like, it can be easy to exceed N.  In this case,</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * even though internally the problem could be detected at mutation time, it will be reported</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * in the next emit_serialization() call (as mandated by the concept API).  Specifically</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * error::Code::S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG shall be emitted.  See &quot;Reasonable uses&quot; below for</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * discussion on avoiding this fate.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * ### Reasonable uses ###</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * This is suitable for transmission via a Blob_sender (or Native_handle_sender) wherein each blob (or meta-blob,</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * respectively) sent has either a hard size limit (meaning a Blob_sender::send_blob() or</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * Native_handle_sender::send_native_handle() call will fail if this limit is exceeded) or an effective limit</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * (meaning transmission performance is poor in the same event).  Indeed the use cases that informed this strategy</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * were:</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *   - Blob_stream_mq_sender::send_blob() shall fail if `blob.size() &gt;= N`, where `N` is the message size limit</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *     passed to its ctor.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *   - `Native_socket_stream::send_*()` shall fail if</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *     `blob.size() &gt;= sync_io::Native_socket_stream::S_MAX_META_BLOB_LENGTH`.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *     - Moreover Native_socket_stream informally is documented to feature good performance compared to</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *       the MQ-based streams when not exceeding the &quot;10s-of-KiB range&quot; (quoting its doc header as of this writing).</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * In &quot;Failure mode&quot; above we pointed out an immediate danger if one uses Heap_fixed_builder to naively serialize</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * arbitrary user-supplied schemas.  Simply put, if one mutates payload_msg_builder() in such a</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * way as to introduce a big leaf, such as a large image blob,</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * then emit_serialization()) will emit error::Code::S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG; and that&#39;s the end</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * of that.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * Even if one avoids this somehow -- let&#39;s say by always fragmenting large things into smaller-size leaves</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * (itself undesirable: the point of serialization of structured data is to not have to worry about data representation</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * at the application level) -- this can lead to, well, a fragmented representation, inefficiently using each N-sized</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * segment with too much unused space.  So what to do?</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * One could write a builder similar to Heap_fixed_builder minus the `_fixed` part; certainly capnp</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * supplies the tools needed to simply allocate large-enough segments (internally, a `capnp::MallocMessageBuilder`-like</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * `MessageBuilder` is used already; we&#39;d just need to use different</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * knob values on `MallocMessageBuilder` or similar and be less draconian in what segment sizes</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * emit_serialization()) will allow).  Of course then the transport mechanism used for the resulting segments would need</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * to be able to handle larger blobs.  Blob_stream_mq_sender already supports larger max message sizes, and</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * Native_socket_stream with a larger or variable `S_MAX_META_BLOB_LENGTH` could be written.  Or even without</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * that one could split any too-large segments across multiple blobs.  However that&#39;s</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * hardly consolation in practice: too much RAM use could result; and/or the copying involved would eventually</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * prove too expensive.  So... probably the non-`_fixed`/multi-blob-segment approaches are not good enough,</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * at least not in general.  So what to do?</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * At least one approach is to use a 2-layer approach.  The true serialization of the user&#39;s schema could</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * be placed in SHared Memory (SHM).  Then only a handle (or handles) to this SHM-stored serialization could</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * be transmitted via Heap_fixed_builder; even a *single* segment of small size would be enough to transmit</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * as much, as each handle is (more or less) a pointer.  Although the SHM-based builder (documented elsewhere)</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * would be the one used at the higher level, internally it would leverage Heap_fixed_builder to transmit the</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * handle(s) to SHM.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * Hence Heap_fixed_builder remains of use; but keep in mind the above limitations and (at least its original)</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * intended use.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * The above discussion is a more specific treatment of the outer-serialization/inner-serialization discussion</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * in the Struct_builder concept doc header.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * ### Implementation ###</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * If one is familiar with capnp, then one can probably quickly guess how this class template accomplishes</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * what it promises in just the brief summary at the top of this doc header:</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * Heap_fixed_builder_capnp_message_builder is what we use internally; it&#39;s like `MallocMessageBuilder`</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * but (1) mandates the equivalent of `AllocationStrategy::FIXED_SIZE` always and (2) has support</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * for a framing prefix and postfix coexisting within each allocated buffer per segment</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * (per our ctor args).  As it must, that builder (like `MallocMessageBuilder`) is documented</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * to allocate a larger-than-N segment if necessary to encode a particular too-large leaf.</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * We do not stop this in and of itself; but emit_serialization() simply refuses to return this resulting serialization,</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * if it detects than indeed such a segment had to be allocated during preceding payload_msg_builder() mutations.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * So `*this` will allocate and eat the needed RAM; but it simply will refuse to return it `public`ly.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * @see Heap_reader</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *      Counterpart Struct_reader implementation that can deserialize data that this has serialized.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * @see Struct_builder: implemented concept.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> */</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">  130</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a> :</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>  <span class="keyword">public</span> flow::log::Log_context</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>{</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"></span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   * Implements Struct_builder::Config sub-concept.  In this impl: The data members control Heap_fixed_builder&#39;s</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   * behavior as follows:</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   *</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   * Heap_fixed_builder ctor configured by Config creates builder that shall heap-allocate segments of the given size on</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">   * demand subsequently.  A successful Heap_fixed_builder::emit_serialization() call shall return individual</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">   * segment sizes never exceeding #m_segment_sz (for the [`begin()`, `end()`) area), with</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">   * `start() == #m_frame_prefix_sz`, and with `capacity() - start() - size() &gt;= #m_frame_postfix_sz`.</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   *</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * However, internally, larger segments may still be allocated, namely if a Heap_fixed_builder::payload_msg_builder()</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   * mutation supplies a too-large leaf -- but, if this occurs, Heap_fixed_builder::emit_serialization() shall</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   * emit an error and no successful serialization.  That said be aware you&#39;ll still be charged for the resulting</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">   * RAM use in the meantime.  Informal recommendations:</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">   *   - Do not use Heap_fixed_builder if this is a danger given the schema in question.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   *     See Heap_fixed_builder doc header for discussion of alternative approaches.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   *   - If the problem does occur (Heap_fixed_builder::emit_serialization() does emit the error) nevertheless,</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   *     it is pointless to keep using `*this`; destroy it and take the appropriate exceptional-error-contingency steps.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   */</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">  154</a></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Config</a></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>  {</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>    <span class="comment">// Types.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"></span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">    /// Implements concept API.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9fa5b2a78f33981eaee67e48de29c73c">  159</a></span><span class="comment"></span>    <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Builder</a> = <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a6debedf2ddfff80f269d296c24686add">Heap_fixed_builder</a>;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"></span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">    /// Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a8e16bef50eeda7c1af3b7caaa862fe73">  164</a></span><span class="comment"></span>    flow::log::Logger* <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a8e16bef50eeda7c1af3b7caaa862fe73">m_logger_ptr</a>;<span class="comment"></span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b">  166</a></span><span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b">m_segment_sz</a>;<span class="comment"></span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88">  168</a></span><span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88">m_frame_prefix_sz</a>;<span class="comment"></span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">    /// See `struct` doc header.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#ac0f5855ff005915ead9b7b109423408c">  170</a></span><span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#ac0f5855ff005915ead9b7b109423408c">m_frame_postfix_sz</a>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>  }; <span class="comment">// class Config</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"></span> </div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">   * Implements concept API.  This being a non-zero-copy Struct_builder, no information is needed for</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment">   * emit_serialization() beyond the payload itself.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">   */</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#ab01fea591145a42c216a5bb396cf0be7">  177</a></span>  <span class="keyword">using </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Null__session.html">Session</a> = <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Null__session.html">Null_session</a>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"></span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   */</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a6debedf2ddfff80f269d296c24686add">  185</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a6debedf2ddfff80f269d296c24686add">Heap_fixed_builder</a>();</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"></span> </div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   * Implements concept API.  See Config doc header for information on how `*this` behavior is controlled by `config`.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   *</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   * @param config</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   *</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   */</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a6debedf2ddfff80f269d296c24686add">Heap_fixed_builder</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Config</a>&amp; config);</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"></span> </div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">  /// Disallow copy construction.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a66e223d5706a98e64782f20187c795dd">  198</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a66e223d5706a98e64782f20187c795dd">Heap_fixed_builder</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"></span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">   *</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   *</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   */</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#aec92902440d6705137065b4463ef2e11">  208</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#aec92902440d6705137065b4463ef2e11">Heap_fixed_builder</a>(<a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp;&amp; src);</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"></span> </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * Implements concept API.  In this impl: frees all segments allocated on-demand so far.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   * @see Struct_builder::~Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   */</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#aa670a6356fe677ae5b1e629a3964b355">~Heap_fixed_builder</a>();</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span> </div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"></span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">  /// Disallow copy assignment.</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#ad1f2df842a49ea376749893af71a7a07">  219</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#ad1f2df842a49ea376749893af71a7a07">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"></span> </div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   *</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   *</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * @see Struct_builder::Struct_builder(): implemented concept.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   */</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a5cc609dab2a244f8f9ba8ebe2c901cfe">  230</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a5cc609dab2a244f8f9ba8ebe2c901cfe">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">Heap_fixed_builder</a>&amp;&amp; src);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"></span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   *</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   *</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   * @see Struct_builder::payload_msg_builder(): implemented concept.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   */</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>  <a class="code hl_class" href="classCapnp__msg__builder__interface.html">Capnp_msg_builder_interface</a>* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a0c054e351753ce326620aa1dec12d923">payload_msg_builder</a>();</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"></span> </div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * ### Errors ###</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   * As discussed in class doc header, you should be on guard for the particular error</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   * error::Code::S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG.  See class doc header for discussion on how to avoid</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   * it.  As of this writing no other failure modes exist.</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   *</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * @param target_blobs</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   *        See above.  Also recall (see ctor) that for each returned `blob`:</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   *        individual segment sizes shall never exceed</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   *        Config::m_segment_sz (for the [`begin()`, `end()`) area), with `start() == m_frame_prefix_sz`, and</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   *        with `capacity() - start() - size() &gt;= m_frame_postfix_sz`.</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * @param session</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *        See above.  In this case the proper value is `NULL_SESSION`.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *        See above.  #Error_code generated: error::Code::S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG (a previous</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   *        mutation introduced a leaf whose serialization would necessitate allocating a segment exceeding</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   *        Config::m_segment_sz -- see ctor -- in size).</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   *</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * @see Struct_builder::emit_serialization(): implemented concept.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   */</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a9fb6b2727c7cc0fb8fe7d231385b5517">emit_serialization</a>(<a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">Segment_ptrs</a>* target_blobs, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Null__session.html">Session</a>&amp; session, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment"></span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   *</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   *</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * @see Struct_builder::n_serialization_segments(): implemented concept.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   */</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a0f8b3c876c577aa0550d13faa60e30d2">n_serialization_segments</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment"></span> </div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">  /// Alias for the capnp `MallocMessageBuilder`-like serialization engine of ours.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a219ab2ebe348b0e45d4a67d414cda199">  278</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder__capnp__message__builder.html">Capnp_heap_engine</a> = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder__capnp__message__builder.html">Heap_fixed_builder_capnp_message_builder</a>;</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span> </div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment"></span> </div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">  /// See ctor.  We only store it to be able to emit `S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG` in emit_serialization().</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#afa719b263e06eb7359b948a36f251485">  283</a></span><span class="comment"></span>  <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#afa719b263e06eb7359b948a36f251485">m_segment_sz</a>;</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment"></span> </div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * The capnp builder engine which really does the work including owning the needed allocated segments so far.</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * payload_msg_builder() simply returns (up-cast of) `&amp;m_engine`.</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   *</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * ### Why the `unique_ptr` wrapper? ###</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * This is subtler than it appears: We need to be move-ctible and move-assignable; and #m_engine therefore</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * does too -- and in fact #Capnp_heap_engine *is*.  So the `unique_ptr` wrapping appears superfluous and a</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * waste of compute and space at least.  However, see the note on move-ctibility/assignability in</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * Heap_fixed_builder_capnp_message_builder doc header: It *is* those things, because super-class</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * (interface) #Capnp_msg_builder_interface is, but any #Capnp_msg_builder_interface sub-class&#39;s move (if available)</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * has to copy ~200 bytes at least.  Whether the extra alloc/dealloc is better than a copy of that length is a</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * bit questionable, but we suspect it is at least somewhat better.</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   *</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * As a side benefit: it&#39;s an easy way to detect a moved-from `*this` and `assert()` in some situations.</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   */</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a8f8e07a71aa5e47d6b8094b2a004cc7d">  300</a></span>  boost::movelib::unique_ptr&lt;Capnp_heap_engine&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a8f8e07a71aa5e47d6b8094b2a004cc7d">m_engine</a>;</div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span>}; <span class="comment">// class Heap_fixed_builder</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment"></span> </div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">/**</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment"> * Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_builder</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment"> * or any other builder that produces segments directly readable via `SegmentArrayMessageReader`.</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"> *</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment"> * While written originally specificaly as the counterpart to Heap_fixed_builder, it would work with any</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment"> * builder that produces an equivalent serialization modulo using potentially different segment sizes.</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment"> * That is why it is called `Heap_reader` -- not `Heap_reader`.</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment"> *</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment"> * The most important thing to recognize about Heap_reader: add_serialization_segment() -- which is required</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment"> * (by the concept) to acquire and return memory segments of the size requested by the user -- shall allocate</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"> * a new `Blob` of the specified size in regular heap (via `new[]`, that is).</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment"> *</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment"> * ### Possible futher impls that would iterate upon Heap_reader ###</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment"> * See Struct_reader &quot;Allocation and perf&quot; doc header section.  It discusses, indirectly, ideas for</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment"> * other reader impls that would be compatible with Heap_fixed_builder (and equivalents) but that</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment"> * would obtain from sources other than `new`ing in regular heap.  E.g.: fixed reused `Blob`; pool allocation.</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment"> *</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment"> * @see Heap_fixed_builder</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment"> *      A counterpart Struct_builder implementation that can create compatible serializations.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment"> * @see Struct_reader: implemented concept.</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment"> */</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">  324</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">Heap_reader</a> :</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span>  <span class="keyword">public</span> flow::log::Log_context,</div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span>{</div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment"></span> </div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">  /// Implements Struct_reader::Config sub-concept.</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">  332</a></span><span class="comment"></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">Config</a></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span>  {</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span>    <span class="comment">// Types.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment"></span> </div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">    /// Implements concept API.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#a415a47dc47b8115093c8a42734f9602c">  337</a></span><span class="comment"></span>    <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">Reader</a> = <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a2dd5635aa61c4d562427b32a1266bac1">Heap_reader</a>;</div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span> </div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment"></span> </div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">    /// Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#a7c2548263f04d8c37b846b534a874917">  342</a></span><span class="comment"></span>    flow::log::Logger* <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#a7c2548263f04d8c37b846b534a874917">m_logger_ptr</a>;</div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment"></span> </div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">     * Best guess for how many times you expect to call add_serialization_segment(); or 0 if you have no guess.</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">     * This is a (fairly minor as of this writing) optimization opportunity; an internal container may be</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">     * `reserve()`d preventing future reallocs.</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">     */</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#aad4ca0248c1ac0c869ab6033d1d43bed">  349</a></span>    <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#aad4ca0248c1ac0c869ab6033d1d43bed">m_n_segments_est</a>;</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>  }; <span class="comment">// class Config</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span> </div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment"></span> </div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * Implements concept API.  See Config doc header for information on how `*this` behavior is controlled by `config`.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * @param config</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   *</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * @see Struct_reader::Struct_reader(): implemented concept.</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   */</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a2dd5635aa61c4d562427b32a1266bac1">Heap_reader</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">Config</a>&amp; config);</div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment"></span> </div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * Implements concept API.  In this impl: frees all segments allocated via add_serialization_segment() so far.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   * @see Struct_reader::~Struct_reader(): implemented concept.</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   */</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span>  <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a88e0a260e09275c1017719028288e413">~Heap_reader</a>();</div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span> </div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment"></span> </div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   * Implements concept API.  Reminder: you must `.resize()` the returned `Blob` in-place to indicate the</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * size of the actual segment (and possibly omitting prefix or postfix frame data), before attempting</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * deserialization().</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   *</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * @param max_sz</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * @return See above.  Note: This impl never returns null.  However any code relying on the concept</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   *         Struct_reader, and not this specific impl (Heap_reader), should naturally refrain</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *         from relying on this fact.  Struct_reader::add_serialization_segment() may return null.</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   *</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * @see Struct_reader::add_serialization_segment(): implemented concept.</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   */</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>  flow::util::Blob* <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aafa83559c9f91eabd128271c58cf2832">add_serialization_segment</a>(<span class="keywordtype">size_t</span> max_sz);</div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment"></span> </div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * Implements concept API.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   *</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * @tparam Struct</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   *        See above.  #Error_code generated:</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   *        error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS (add_serialization_segment() was never called),</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   *        error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED (add_serialization_segment()-returned segment</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   *        was modified subsequently to start at a misaligned address).</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   *</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   * @see Struct_reader::deserialization(): implemented concept.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   */</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct&gt;</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>  <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a1e283b4a4a72e34501dad6caec505757">deserialization</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span> </div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment"></span> </div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">  /// Alias for the capnp `SegmentArrayMessageReader` deserialization engine.</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a8b6ab4b8c69d637a08830f15934cbd9b">  408</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a8b6ab4b8c69d637a08830f15934cbd9b">Capnp_heap_engine</a> = ::capnp::SegmentArrayMessageReader;</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"></span> </div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">  /// Alias to pointer to #Capnp_heap_engine.</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a7f45f5d9c563a9c513b90f4a2df693a6">  411</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a7f45f5d9c563a9c513b90f4a2df693a6">Capnp_heap_engine_ptr</a> = boost::movelib::unique_ptr&lt;Capnp_heap_engine&gt;;</div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment"></span> </div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * Alias to capnp type that&#39;s similar to `boost::asio::const_buffer` but stores `word*` and `word` count</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * instead of `uint8_t*` and byte count.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   */</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aea8a3f7dcb5c6f021bb19397b3b1705e">  417</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aea8a3f7dcb5c6f021bb19397b3b1705e">Capnp_word_array_ptr</a> = kj::ArrayPtr&lt;const ::capnp::word&gt;;</div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span> </div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment"></span> </div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * The actual serialization supplied so far, as divided up into segments (`Blob`s -- byte arrays).</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   * Before the first add_serialization_segment(): empty.</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   * After that but before deserialization(): Each `Blob`, except possibly the last, is finalized.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   * At entry to deserialization() or later: Each `Blob` is finalized.</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   */</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">  427</a></span>  std::vector&lt;boost::movelib::unique_ptr&lt;flow::util::Blob&gt;&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>;</div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment"></span> </div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   * After deserialization(), capnp-targeted data structure which is essentially `vector&lt;&gt;` of each</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * `Blob::const_buffer()` from #m_serialization_segments, in order, except instead of a given `const_buffer`</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * it&#39;s the capnp-style data structure that stores a `word*` and `word` count (instead of</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * `uint8_t*` and byte count).  This must be alive while #m_engine is non-null, so from deserialization() on;</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * capnp&#39;s #m_engine saves the pointer `&amp;m_capnp_segments[0]` and `m_capnp_segments.size()`.</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   */</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b">  436</a></span>  std::vector&lt;Capnp_word_array_ptr&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b">m_capnp_segments</a>;</div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment"></span> </div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   * The capnp reader engine, as set in the deserialization() call and corresponding to the</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * `Struct::Reader` it returned; or null if deserialization() has not yet been called.  In terms of data this, really,</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   * just stores pointers into the backing serialization -- the blobs #m_serialization_segments.</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * deserialization()-returned value then adds the capnp structured-data accessors which hop around those segments,</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * obtaining individual values directly from the segment blobs #m_serialization_segments.</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   */</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">  445</a></span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a7f45f5d9c563a9c513b90f4a2df693a6">Capnp_heap_engine_ptr</a> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">m_engine</a>;</div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span>}; <span class="comment">// class Heap_reader</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment"></span> </div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">/**</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment"> * Convenience alias: Use this when constructing a struc::Channel with tag</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment"> * Channel_base::S_SERIALIZE_VIA_HEAP.</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment"> *</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment"> * See Channel_base::Serialize_via_heap doc header for when/how to use.</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment"> *</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment"> * Tip: `Sync_io_obj` member alias will get you the `sync_io`-pattern counterpart.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment"> *</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment"> * Unable to put it in ..._fwd.hpp, because it relies on nested class inside incomplete type.</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment"> */</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Channel_obj, <span class="keyword">typename</span> Message_body&gt;</div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno"><a class="line" href="namespaceipc_1_1transport_1_1struc.html#aca041b0efd4a9ae18e10088b2ee3c052">  460</a></span><span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Channel_via_heap</a></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span>  = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Channel</a>&lt;Channel_obj, Message_body,</div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span>            <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Heap_fixed_builder::Config</a>, <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">Heap_reader::Config</a>&gt;;</div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span> </div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span> </div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span> </div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Struct&gt;</div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a1e283b4a4a72e34501dad6caec505757">  469</a></span><span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a> <a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a1e283b4a4a72e34501dad6caec505757">Heap_reader::deserialization</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span>{</div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span>  <span class="keyword">using </span>flow::error::Runtime_error;</div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span>  <span class="keyword">using </span>flow::util::buffers_dump_string;</div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span>  <span class="keyword">using </span>boost::movelib::make_unique;</div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span>  <span class="keyword">using </span>std::vector;</div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span>  using ::capnp::word;</div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span>  <span class="keyword">using </span>Capnp_word_array_array_ptr = kj::ArrayPtr&lt;const Capnp_word_array_ptr&gt;;</div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span>  <span class="keyword">using </span>Capnp_struct_reader = <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">Struct::Reader</a>;</div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span>  <span class="keyword">using </span>Capnp_heap_engine_opts = ::capnp::ReaderOptions;</div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span> </div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span>  <span class="comment">// See explanation and associated to-do in shm::Reader::deserialization(); applies equally here.</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span>  <span class="keyword">constexpr</span> Capnp_heap_engine_opts RDR_OPTIONS = { std::numeric_limits&lt;uint64_t&gt;::max() / <span class="keyword">sizeof</span>(word),</div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span>                                                   Capnp_heap_engine_opts{}.nestingLimit };</div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span> </div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span>  <span class="comment">// Helper to emit error via usual semantics.  We return a ref so can&#39;t use FLOW_ERROR_EXEC_AND_THROW_ON_ERROR().</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span>  <span class="keyword">const</span> <span class="keyword">auto</span> emit_error = [&amp;](<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; our_err_code) -&gt; Capnp_struct_reader</div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span>  {</div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span>    <span class="keywordflow">if</span> (err_code)</div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span>    {</div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span>      *err_code = our_err_code;</div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span>      <span class="keywordflow">return</span> Capnp_struct_reader();</div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span>    }</div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span>    <span class="keywordflow">throw</span> Runtime_error(our_err_code, <span class="stringliteral">&quot;Heap_reader::deserialization()&quot;</span>);</div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span>    <span class="keywordflow">return</span> Capnp_struct_reader(); <span class="comment">// Doesn&#39;t get here.</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span>  };</div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span> </div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span>  <span class="keywordflow">if</span> (<a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>.empty())</div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span>  {</div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span>    <span class="keywordflow">return</span> emit_error(<a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b">error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a>);</div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span>  }</div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span>  <span class="comment">// else: OK so far.</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span> </div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span>  assert((!<a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">m_engine</a>) &amp;&amp; <span class="stringliteral">&quot;Do not call deserialization() more than once.&quot;</span>);</div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span> </div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span>  <span class="comment">// Set up capnp ArrayPtr&lt;ArrayPtr&gt;.  ArrayPtr is a ptr (to word) + size (in `word`s).  The backing vector:</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span>  <span class="keyword">auto</span>&amp; capnp_segs = <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b">m_capnp_segments</a>;</div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span>  assert(<a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b">m_capnp_segments</a>.empty() &amp;&amp; <span class="stringliteral">&quot;m_capnp_segments should have been empty so far, pre-deserialization().&quot;</span>);</div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span>  capnp_segs.reserve(<a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>.size());</div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span> </div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span>  <span class="keywordtype">size_t</span> idx = 0;</div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; serialization_segment : <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>)</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span>  {</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span>    <span class="keyword">const</span> <span class="keyword">auto</span> data_ptr = serialization_segment-&gt;const_data();</div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span>    <span class="keyword">const</span> <span class="keyword">auto</span> seg_size = serialization_segment-&gt;size();</div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span> </div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span>    <span class="keywordflow">if</span> ((uintptr_t(data_ptr) % <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*)) != 0)</div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span>    {</div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span>      FLOW_LOG_WARNING(<span class="stringliteral">&quot;Heap_reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span>                       <span class="stringliteral">&quot;Serialization segment [&quot;</span> &lt;&lt; idx &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span>                       <span class="stringliteral">&quot;(0 based, of [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>.size() &lt;&lt; <span class="stringliteral">&quot;], 1-based): &quot;</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span>                       <span class="stringliteral">&quot;Heap buffer @[&quot;</span> &lt;&lt; <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(data_ptr) &lt;&lt; <span class="stringliteral">&quot;] sized [&quot;</span> &lt;&lt; seg_size &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span>                       <span class="stringliteral">&quot;Starting pointer is not this-architecture-word-aligned.  Bug?  Misuse of Heap_reader?  &quot;</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span>                       <span class="stringliteral">&quot;Misalignment is against the API use requirements; capnp would complain and fail.&quot;</span>);</div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span>      <span class="keywordflow">return</span> emit_error(<a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406">error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a>);</div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span>    }</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span> </div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span>    FLOW_LOG_TRACE(<span class="stringliteral">&quot;Heap_reader [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span>                   <span class="stringliteral">&quot;Serialization segment [&quot;</span> &lt;&lt; idx &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span>                   <span class="stringliteral">&quot;(0 based, of [&quot;</span> &lt;&lt; <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">m_serialization_segments</a>.size() &lt;&lt; <span class="stringliteral">&quot;], 1-based): &quot;</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span>                   <span class="stringliteral">&quot;Heap buffer @[&quot;</span> &lt;&lt; <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(data_ptr) &lt;&lt; <span class="stringliteral">&quot;] sized [&quot;</span> &lt;&lt; seg_size &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span>                   <span class="stringliteral">&quot;Feeding into capnp deserialization engine.&quot;</span>);</div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span>    FLOW_LOG_DATA(<span class="stringliteral">&quot;Segment contents: &quot;</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span>                  <span class="stringliteral">&quot;[\n&quot;</span> &lt;&lt; buffers_dump_string(serialization_segment-&gt;const_buffer(), <span class="stringliteral">&quot;  &quot;</span>) &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span> </div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span>    capnp_segs.emplace_back(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>word*<span class="keyword">&gt;</span>(data_ptr), <span class="comment">// uint8_t* -&gt; word* = OK given C++ aliasing rules.</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span>                            seg_size / <span class="keyword">sizeof</span>(word)); <span class="comment">// @todo Maybe also check that seg_size is a multiple?  assert()?</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span> </div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span>    ++idx;</div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span>  } <span class="comment">// for (const auto&amp; serialization_segment : m_serialization_segments)</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span> </div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span>  <span class="comment">/* Initialize the deserialization engine by giving it the pointers to/size of the backing segment blobs.</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   * It doesn&#39;t copy this array of pointers/sizes, so that array must stay alive, hence why capnp_segs is</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   * really m_capnp_segments.  To be clear: not only must the blobs stay alive but so must the array referring</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   * to them. */</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span>  <span class="keyword">const</span> Capnp_word_array_array_ptr capnp_segs_ptr(&amp;(capnp_segs.front()), capnp_segs.size());</div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span>  <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">m_engine</a> = make_unique&lt;Capnp_heap_engine&gt;(capnp_segs_ptr, RDR_OPTIONS);</div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span> </div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span>  <span class="keywordflow">if</span> (err_code)</div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span>  {</div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span>    err_code-&gt;clear();</div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span>  }</div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span> </div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span>  <span class="comment">// And lastly set up the structured-accessor API object that&#39;ll traverse those blobs via that engine.</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span>  <span class="keywordflow">return</span> <a class="code hl_variable" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">m_engine</a>-&gt;getRoot&lt;Struct&gt;();</div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span>} <span class="comment">// Heap_reader::deserialization()</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span> </div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span>} <span class="comment">// namespace ipc::transport::struc</span></div>
<div class="ttc" id="aclassCapnp__msg__builder__interface_html"><div class="ttname"><a href="classCapnp__msg__builder__interface.html">Capnp_msg_builder_interface</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Channel_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Channel.html">ipc::transport::struc::Channel</a></div><div class="ttdoc">Owning and wrapping a pre-connected transport::Channel peer (an endpoint of an established channel ov...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp_source.html#l00586">channel.hpp:589</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder__capnp__message__builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder__capnp__message__builder.html">ipc::transport::struc::Heap_fixed_builder_capnp_message_builder</a></div><div class="ttdoc">A capnp::MessageBuilder used by Heap_fixed_builder: similar to a capnp::MallocMessageBuilder with the...</div><div class="ttdef"><b>Definition:</b> <a href="heap__fixed__builder__capnp__msg__builder_8hpp_source.html#l00084">heap_fixed_builder_capnp_msg_builder.hpp:86</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">ipc::transport::struc::Heap_fixed_builder</a></div><div class="ttdoc">Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00130">heap_serializer.hpp:132</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a0c054e351753ce326620aa1dec12d923"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a0c054e351753ce326620aa1dec12d923">ipc::transport::struc::Heap_fixed_builder::payload_msg_builder</a></div><div class="ttdeci">Capnp_msg_builder_interface * payload_msg_builder()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00065">heap_serializer.cpp:65</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a0f8b3c876c577aa0550d13faa60e30d2"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a0f8b3c876c577aa0550d13faa60e30d2">ipc::transport::struc::Heap_fixed_builder::n_serialization_segments</a></div><div class="ttdeci">size_t n_serialization_segments() const</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00125">heap_serializer.cpp:125</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a5cc609dab2a244f8f9ba8ebe2c901cfe"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a5cc609dab2a244f8f9ba8ebe2c901cfe">ipc::transport::struc::Heap_fixed_builder::operator=</a></div><div class="ttdeci">Heap_fixed_builder &amp; operator=(Heap_fixed_builder &amp;&amp;src)</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a66e223d5706a98e64782f20187c795dd"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a66e223d5706a98e64782f20187c795dd">ipc::transport::struc::Heap_fixed_builder::Heap_fixed_builder</a></div><div class="ttdeci">Heap_fixed_builder(const Heap_fixed_builder &amp;)=delete</div><div class="ttdoc">Disallow copy construction.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a6debedf2ddfff80f269d296c24686add"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a6debedf2ddfff80f269d296c24686add">ipc::transport::struc::Heap_fixed_builder::Heap_fixed_builder</a></div><div class="ttdeci">Heap_fixed_builder()</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a8f8e07a71aa5e47d6b8094b2a004cc7d"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a8f8e07a71aa5e47d6b8094b2a004cc7d">ipc::transport::struc::Heap_fixed_builder::m_engine</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Capnp_heap_engine &gt; m_engine</div><div class="ttdoc">The capnp builder engine which really does the work including owning the needed allocated segments so...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00300">heap_serializer.hpp:300</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_a9fb6b2727c7cc0fb8fe7d231385b5517"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#a9fb6b2727c7cc0fb8fe7d231385b5517">ipc::transport::struc::Heap_fixed_builder::emit_serialization</a></div><div class="ttdeci">void emit_serialization(Segment_ptrs *target_blobs, const Session &amp;session, Error_code *err_code=0) const</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00072">heap_serializer.cpp:72</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_aa670a6356fe677ae5b1e629a3964b355"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#aa670a6356fe677ae5b1e629a3964b355">ipc::transport::struc::Heap_fixed_builder::~Heap_fixed_builder</a></div><div class="ttdeci">~Heap_fixed_builder()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00057">heap_serializer.cpp:57</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_ad1f2df842a49ea376749893af71a7a07"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#ad1f2df842a49ea376749893af71a7a07">ipc::transport::struc::Heap_fixed_builder::operator=</a></div><div class="ttdeci">Heap_fixed_builder &amp; operator=(const Heap_fixed_builder &amp;)=delete</div><div class="ttdoc">Disallow copy assignment.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_aec92902440d6705137065b4463ef2e11"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#aec92902440d6705137065b4463ef2e11">ipc::transport::struc::Heap_fixed_builder::Heap_fixed_builder</a></div><div class="ttdeci">Heap_fixed_builder(Heap_fixed_builder &amp;&amp;src)</div><div class="ttdoc">Implements concept API.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html_afa719b263e06eb7359b948a36f251485"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html#afa719b263e06eb7359b948a36f251485">ipc::transport::struc::Heap_fixed_builder::m_segment_sz</a></div><div class="ttdeci">size_t m_segment_sz</div><div class="ttdoc">See ctor. We only store it to be able to emit S_INTERNAL_ERROR_SERIALIZE_LEAF_TOO_BIG in emit_seriali...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00283">heap_serializer.hpp:283</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">ipc::transport::struc::Heap_reader</a></div><div class="ttdoc">Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00324">heap_serializer.hpp:327</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a1e283b4a4a72e34501dad6caec505757"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a1e283b4a4a72e34501dad6caec505757">ipc::transport::struc::Heap_reader::deserialization</a></div><div class="ttdeci">Struct::Reader deserialization(Error_code *err_code=0)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00469">heap_serializer.hpp:469</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a2dd5635aa61c4d562427b32a1266bac1"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a2dd5635aa61c4d562427b32a1266bac1">ipc::transport::struc::Heap_reader::Heap_reader</a></div><div class="ttdeci">Heap_reader(const Config &amp;config)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00139">heap_serializer.cpp:139</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a7f45f5d9c563a9c513b90f4a2df693a6"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a7f45f5d9c563a9c513b90f4a2df693a6">ipc::transport::struc::Heap_reader::Capnp_heap_engine_ptr</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Capnp_heap_engine &gt; Capnp_heap_engine_ptr</div><div class="ttdoc">Alias to pointer to Capnp_heap_engine.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00411">heap_serializer.hpp:411</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a86d1fba98bf24c390587893c61174111"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a86d1fba98bf24c390587893c61174111">ipc::transport::struc::Heap_reader::m_serialization_segments</a></div><div class="ttdeci">std::vector&lt; boost::movelib::unique_ptr&lt; flow::util::Blob &gt; &gt; m_serialization_segments</div><div class="ttdoc">The actual serialization supplied so far, as divided up into segments (Blobs – byte arrays).</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00427">heap_serializer.hpp:427</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a88e0a260e09275c1017719028288e413"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a88e0a260e09275c1017719028288e413">ipc::transport::struc::Heap_reader::~Heap_reader</a></div><div class="ttdeci">~Heap_reader()</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00147">heap_serializer.cpp:147</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_a8b6ab4b8c69d637a08830f15934cbd9b"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#a8b6ab4b8c69d637a08830f15934cbd9b">ipc::transport::struc::Heap_reader::Capnp_heap_engine</a></div><div class="ttdeci">::capnp::SegmentArrayMessageReader Capnp_heap_engine</div><div class="ttdoc">Alias for the capnp SegmentArrayMessageReader deserialization engine.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00408">heap_serializer.hpp:408</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_aafa83559c9f91eabd128271c58cf2832"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aafa83559c9f91eabd128271c58cf2832">ipc::transport::struc::Heap_reader::add_serialization_segment</a></div><div class="ttdeci">flow::util::Blob * add_serialization_segment(size_t max_sz)</div><div class="ttdoc">Implements concept API.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8cpp_source.html#l00165">heap_serializer.cpp:165</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_ab56a232e71b862b8f498d04e04450b72"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ab56a232e71b862b8f498d04e04450b72">ipc::transport::struc::Heap_reader::m_engine</a></div><div class="ttdeci">Capnp_heap_engine_ptr m_engine</div><div class="ttdoc">The capnp reader engine, as set in the deserialization() call and corresponding to the Struct::Reader...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00445">heap_serializer.hpp:445</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_ae514982795db7d0301a7929d1006d30b"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b">ipc::transport::struc::Heap_reader::m_capnp_segments</a></div><div class="ttdeci">std::vector&lt; Capnp_word_array_ptr &gt; m_capnp_segments</div><div class="ttdoc">After deserialization(), capnp-targeted data structure which is essentially vector&lt;&gt; of each Blob::co...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00436">heap_serializer.hpp:436</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__reader_html_aea8a3f7dcb5c6f021bb19397b3b1705e"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aea8a3f7dcb5c6f021bb19397b3b1705e">ipc::transport::struc::Heap_reader::Capnp_word_array_ptr</a></div><div class="ttdeci">kj::ArrayPtr&lt; const ::capnp::word &gt; Capnp_word_array_ptr</div><div class="ttdoc">Alias to capnp type that's similar to boost::asio::const_buffer but stores word* and word count inste...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00417">heap_serializer.hpp:417</a></div></div>
<div class="ttc" id="aheap__fixed__builder__capnp__msg__builder_8hpp_html"><div class="ttname"><a href="heap__fixed__builder__capnp__msg__builder_8hpp.html">heap_fixed_builder_capnp_msg_builder.hpp</a></div></div>
<div class="ttc" id="aipc__transport__structured_2src_2ipc_2transport_2struc_2error_8hpp_html"><div class="ttname"><a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1error_html_a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b">ipc::transport::struc::error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a></div><div class="ttdeci">@ S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</div><div class="ttdoc">Structured message deserialization: Tried to deserialize without enough input segments (e....</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1error_html_a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406">ipc::transport::struc::error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a></div><div class="ttdeci">@ S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</div><div class="ttdoc">Structured message deserialization: An input segment is not aligned as required.</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_af94f8698ca62a84d6366aaa931375d41"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">ipc::transport::struc::shm::classic::Reader</a></div><div class="ttdeci">Reader&lt; ipc::shm::classic::Pool_arena &gt; Reader</div><div class="ttdoc">Convenience alias: transport::struc::shm::Reader that works with boost.ipc.shm pools from ipc::shm::c...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00039">classic_fwd.hpp:39</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html">ipc::transport::struc</a></div><div class="ttdoc">Sub-module of Flow-IPC module ipc::transport providing transmission of structured messages specifical...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8cpp_source.html#l00030">channel.cpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_a82a69eaa39cbe8a002de1266f1cbb5cb"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#a82a69eaa39cbe8a002de1266f1cbb5cb">ipc::transport::struc::Segment_ptrs</a></div><div class="ttdeci">std::vector&lt; flow::util::Blob * &gt; Segment_ptrs</div><div class="ttdoc">Sequence of 1+ Blob pointers to blobs which must stay alive while these pointers may be dereferenced,...</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00122">struc_fwd.hpp:122</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">ipc::transport::struc::Heap_fixed_builder::Config</a></div><div class="ttdoc">Implements Struct_builder::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00154">heap_serializer.hpp:155</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html_a8e16bef50eeda7c1af3b7caaa862fe73"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a8e16bef50eeda7c1af3b7caaa862fe73">ipc::transport::struc::Heap_fixed_builder::Config::m_logger_ptr</a></div><div class="ttdeci">flow::log::Logger * m_logger_ptr</div><div class="ttdoc">Logger to use for logging subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00164">heap_serializer.hpp:164</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html_a9e759098107b22d8e40238eeb74c7f0b"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#a9e759098107b22d8e40238eeb74c7f0b">ipc::transport::struc::Heap_fixed_builder::Config::m_segment_sz</a></div><div class="ttdeci">size_t m_segment_sz</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00166">heap_serializer.hpp:166</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html_ac0f5855ff005915ead9b7b109423408c"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#ac0f5855ff005915ead9b7b109423408c">ipc::transport::struc::Heap_fixed_builder::Config::m_frame_postfix_sz</a></div><div class="ttdeci">size_t m_frame_postfix_sz</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00170">heap_serializer.hpp:170</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html_aeb6fcd8308642adbcb6edcd564375c88"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html#aeb6fcd8308642adbcb6edcd564375c88">ipc::transport::struc::Heap_fixed_builder::Config::m_frame_prefix_sz</a></div><div class="ttdeci">size_t m_frame_prefix_sz</div><div class="ttdoc">See struct doc header.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00168">heap_serializer.hpp:168</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">ipc::transport::struc::Heap_reader::Config</a></div><div class="ttdoc">Implements Struct_reader::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00332">heap_serializer.hpp:333</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config_html_a7c2548263f04d8c37b846b534a874917"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#a7c2548263f04d8c37b846b534a874917">ipc::transport::struc::Heap_reader::Config::m_logger_ptr</a></div><div class="ttdeci">flow::log::Logger * m_logger_ptr</div><div class="ttdoc">Logger to use for logging subsequently.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00342">heap_serializer.hpp:342</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config_html_aad4ca0248c1ac0c869ab6033d1d43bed"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html#aad4ca0248c1ac0c869ab6033d1d43bed">ipc::transport::struc::Heap_reader::Config::m_n_segments_est</a></div><div class="ttdeci">size_t m_n_segments_est</div><div class="ttdoc">Best guess for how many times you expect to call add_serialization_segment(); or 0 if you have no gue...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00349">heap_serializer.hpp:349</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Null__session_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Null__session.html">ipc::transport::struc::Null_session</a></div><div class="ttdoc">Value for Struct_builder::Session when no extra information is needed when serializing Struct_builder...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00045">heap_serializer.hpp:45</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
